Replace update functions with a merge function #51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zknill
force-pushed
the
feature/COL-40-replace-update-function-merge-function
branch
from
cdb726f to
99e6914
Compare
Replace the per-channel-per-event update function mapping with a single merge function. This makes the UpdatesRegistry redundant, as we don't need a class to hold the old mapping: "channel -> eventName -> function" Update the tests, and rename some update terminology to merge. Also: - accept the channel name as a constructor argument to the Model. squash
The StreamFactory is now only responsible for creating streams given the channel name and the set of default options. It doesn't hold on to the references to stream after creating them.
zknill
force-pushed
the
feature/COL-40-replace-update-function-merge-function
branch
from
99e6914 to
2f9adbd
Compare
mschristensen
requested changes
Oct 16, 2023
| [event: string]: UpdateFunc<T>; | ||
| }; | ||
| }; | ||
| $merge?: MergeFunc<T>; |
There was a problem hiding this comment.
I think we can drop the $ prefixes, wdythink? Originally this was inteneded to distinguish between user-defined functions and those exposed on the model, although we're namespacing so we don't really need it.
There was a problem hiding this comment.
Doesn't have to be in this PR - I have created a ticket to do this separately for all registrations: https://ably.atlassian.net/browse/COL-518
src/Model.discontinuity.test.ts
Outdated
| @@ -9,7 +9,7 @@ import { MutationMethods } from './types/mutations.js'; | |||
|
|
|||
| vi.mock('ably/promises'); | |||
|
|
|||
| interface ModelTestContext extends ModelOptions {} | |||
| type ModelTestContext = { channelName: string } & ModelOptions; | |||
There was a problem hiding this comment.
Should we just store the channelName on the ModelOptions directly?
src/Model.ts
Outdated
| logger: options.logger, | ||
| eventBufferOptions: options.eventBufferOptions, | ||
| }); | ||
| this.stream = this.streamFactory.newStream({ channel: channel }); |
There was a problem hiding this comment.
Can just be { channel }
mschristensen
approved these changes
Oct 16, 2023
zknill
deleted the
feature/COL-40-replace-update-function-merge-function
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replace the per-channel-per-event update function mapping with a single merge function. This makes the UpdatesRegistry redundant, as we don't need a class to hold the old mapping: "channel -> eventName -> function"
Update the tests, and rename some update terminology to merge.
Also:
channel name and the set of default options. It doesn't hold on to the
references to stream after creating them.